

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Package [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Automation Interface,Automation Interface Repository Package,Package,Package Automation Interface Repository,Repository,Repository Package">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Package</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="modelwatcher.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="projectissues_2.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_SubHeadingL1"><span class="f_SubHeadingL1">public Class</span></p>
<p class="p_BodyText"><span class="f_BodyText">A </span><span class="f_BodyText" style="font-style: italic;">Package</span><span class="f_BodyText"> object corresponds to a Package element in the Enterprise Architect </span><span class="f_UIControl">Project Browser</span><span class="f_BodyText">. It is accessed either through the </span><span class="f_BodyText">Repository</span><span class="f_BodyText" style="font-style: italic;"> Models</span><span class="f_BodyText"> collection (a Model is a special form of Package) or through the </span><span class="f_BodyText">Package</span><span class="f_BodyText" style="font-style: italic;"> Packages</span><span class="f_BodyText"> collection. Note that a Package has an Element object as an attribute; this corresponds to an Enterprise Architect Package element in the </span><span class="f_BodyText" style="font-style: italic;">t_object</span><span class="f_BodyText"> table and is used to associate additional information (such as scenarios and constraints) with the logical package. To set additional information for a package, reference the Element object directly. Also note that if you add a Package to a diagram, you should add an instance of the element (not the Package itself) to the </span><span class="f_BodyText" style="font-style: italic;">DiagramObjects</span><span class="f_BodyText"> collection for a diagram.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Associated table in .EAP file:</span><span class="f_BodyText" style="font-style: italic;"> t_package</span></p>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Package Attributes</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" bgcolor="#e3e6ed" style="width:199px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Attribute</span></p>
</td>
<td valign="top" width="91" bgcolor="#e3e6ed" style="width:91px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="425" bgcolor="#e3e6ed" style="width:425px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Notes</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Alias</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Alias.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">BatchLoad</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Flag to indicate that the package is batch loaded during batch import from controlled packages. </span><span class="f_Tabletext" style="color: #ff0000;">Not yet implemented.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">BatchSave</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Boolean value to indicate whether the package is included in the batch XMI export list or not.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">CodePath</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The path to where associated source code is found. Not currently used.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Connectors</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Collection of connectors.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Created</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Date</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Date the package was created.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Diagrams</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. A collection of diagrams contained in this package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Element</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Object</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. The associated element object. Use to set element type information for a package, including Stereotype, Complexity, Alias, Author, Constraints and Scenarios.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Elements</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. A collection of elements that belong to this package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Flags</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Extended information about the package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">IsControlled</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Indicates if the package has been marked as </span><span class="f_Tabletext" style="font-style: italic;">Controlled</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">IsModel</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Indicates if the package is a model or a package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">IsNamespace</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. </span><span class="f_Tabletext" style="font-weight: bold;">True</span><span class="f_Tabletext"> is 'package is a Namespace root'. Use </span><span class="f_Tabletext" style="font-weight: bold;">0</span><span class="f_Tabletext"> and </span><span class="f_Tabletext" style="font-weight: bold;">1</span><span class="f_Tabletext"> to set </span><span class="f_Tabletext" style="font-weight: bold;">False</span><span class="f_Tabletext"> and </span><span class="f_Tabletext" style="font-weight: bold;">True</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">IsProtected</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Indicates if the package has been marked as </span><span class="f_Tabletext" style="font-style: italic;">Protected</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">IsVersionControlled</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read. Indicates whether or not this package is under version control.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LastLoadDate</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Date</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The date XML was last loaded for the package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LastSaveDate</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Date</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The date XML was last saved from the package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">LogXML</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Indicates if XMI export information is to be logged.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Modified</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Date</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Date the package was last modified.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Name</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The name of the package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Notes</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Notes about this package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ObjectType</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="objecttypeenum.htm">ObjectType</a></span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. Distinguishes objects referenced through a Dispatch interface.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Owner</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The package owner when using controlled packages.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">PackageGUID</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Variant</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. The global Package ID. Valid across models.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">PackageID</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. The local Package ID number. Valid only in this model file.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Packages</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;"><a href="collection.htm">Collection</a></span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read only. A collection of contained packages that can be walked through.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ParentID</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long </span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The ID of the package that is the parent of this one. </span><span class="f_Tabletext" style="font-weight: bold;">0</span><span class="f_Tabletext"> indicates this package is a </span><span class="f_Tabletext" style="font-style: italic;">model</span><span class="f_Tabletext"> (that is, it has no parent).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">TreePos</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The relative position in the tree compared to other packages (use to sort packages).</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">UMLVersion</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The UML version for XMI export purposes.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">UseDTD</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. Indicates if a DTD is to be used when exporting XMI.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Version</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The version of the package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="199" style="width:199px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">XMLPath</span></p>
</td>
<td valign="top" width="91" style="width:91px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="425" style="width:425px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Read/Write. The path to where the XML is saved when using controlled packages.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Package Methods</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" bgcolor="#e3e6ed" style="width:197px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Method</span></p>
</td>
<td valign="top" width="93" bgcolor="#e3e6ed" style="width:93px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Type</span></p>
</td>
<td valign="top" width="426" bgcolor="#e3e6ed" style="width:426px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Notes</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ApplyGroupLock (string aGroupName)</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Applies a group lock to the package object, for the specified group, on behalf of the current user.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError()</span><span class="f_Tabletext"> to retrieve error information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameter:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">aGroupName: String - The name of the security group for which to apply the lock.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ApplyUserLock ()</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Applies a user lock to the package object for the current user.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError()</span><span class="f_Tabletext"> to retrieve error information.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Clone</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">LDISPATCH</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Inserts a copy of the package into the same parent as the original package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Returns the newly-created package.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">FindObject (string DottedID)</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">LPDISPATCH</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Returns a package, element, attribute or operation matching the parameter </span><span class="f_Tabletext" style="font-style: italic;">DottedID.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameter:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">DottedID: String - Is in the form </span><span class="f_Bulletlist1" style="font-style: italic;">object.object.object</span><span class="f_Bulletlist1"> where </span><span class="f_Bulletlist1" style="font-style: italic;">object</span><span class="f_Bulletlist1"> is replaced by the name of a package, element attribute or operation. Examples include MyNamespace.Class1, CStudent.m_Name, MathClass.DoubleIt(int)</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">If the DottedID is not found, an error is returned: </span><span class="f_Tabletext" style="font-style: italic;">Can't find matching object</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">GetLastError ()</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">String</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Returns a string value describing the most recent error that occurred in relation to this object.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">This function is rarely used as an exception is thrown when an error occurs.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">ReleaseLock ()</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Removes an existing User or Group lock from the package object.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError( )</span><span class="f_Tabletext"> to retrieve error information.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Update ()</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Boolean</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Update the current package object after modification or appending a new item. </span></p>
<p class="p_Tabletext"><span class="f_Tabletext">If </span><span class="f_Tabletext" style="font-weight: bold;">false</span><span class="f_Tabletext"> is returned, check the </span><span class="f_Tabletext" style="font-style: italic;">GetLastError</span><span class="f_Tabletext"> function for more information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Note that a package object also has an </span><span class="f_Tabletext" style="font-style: italic;">element</span><span class="f_Tabletext"> component that must be taken into account. The package object contains information about the package attributes such as hierarchy or contents. The element attribute contains information about, for example, Stereotype, Constraints or Files - all the attributes of a typical element.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">VersionControlAdd (string ConfigGuid, string XMLFile, bool KeepCheckedOut)</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Places the package under version control, using the specified Version Control Configuration and the specified XMI filename.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError( )</span><span class="f_Tabletext"> to retrieve error information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">It is recommended that the package be saved using </span><span class="f_Tabletext" style="font-style: italic;">Update()</span><span class="f_Tabletext"> before calling </span><span class="f_Tabletext" style="font-style: italic;">VersionControlAdd()</span><span class="f_Tabletext">, so that any outstanding changes are not lost.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">ConfigGuid: String - Name corresponding to the Unique ID of the version control configuration to use.</span></li>
<li><span class="f_Bulletlist1">XMLFile: String - Name of the XML file to use for this package. This filename is relative to the Working Copy folder specified for the Config.</span></li>
<li><span class="f_Bulletlist1">KeepCheckedOut</span><span class="f_Tabletext">: Boolean - Specify </span><span class="f_Tabletext" style="font-weight: bold;">True</span><span class="f_Tabletext"> to add to version control and keep package checked-out.</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">VersionControlCheckin (string Comment)</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Perform checkin of the version controlled package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError( )</span><span class="f_Tabletext"> to retrieve error information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Comment: String - Log message that is added to the version controlled file's history (where applicable).</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">VersionControlCheckout (string Comment)</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Perform checkout of the version controlled package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError( ) </span><span class="f_Tabletext">to retrieve error information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Parameters:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Comment: String - Log message that is added to the version controlled file's history (where applicable).</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">VersionControlGetStatus ()</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Long</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Returns the version control status of the package. Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError( ) </span><span class="f_Tabletext">to retrieve error information.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Return value maps to the following enumerated type:</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">enum EnumCheckOutStatus</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">{</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csUncontrolled = 0,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csCheckedIn,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csCheckedOutToThisUser,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csReadOnlyVersion,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csCheckedOutToAnotherUser,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csOfflineCheckedOutToThisUser,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csOfflineNotCheckedOutToThisUser,</span></p>
<p class="p_Tabletext"> &nbsp; &nbsp; &nbsp; &nbsp;<span class="f_Tabletext" style="font-style: italic;">csDeleted</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">}</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">csUncontrolled</span><span class="f_Tabletext"> - Either unable to communicate with the version control provider associated with the package or the package file is unknown to the provider.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">csReadOnlyVersion</span><span class="f_Tabletext"> - Package is marked as read-only. An earlier revision of the package has been retrieved from version control.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">csOfflineCheckedOutToThisUser</span><span class="f_Tabletext"> - Indicates that the package was &quot;checked out&quot; by this user whilst disconnected from version control.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">csOfflineNotCheckedOutToThisUser</span><span class="f_Tabletext"> - Indicates that Enterprise Architect can not currently connect to the version control config and the package was not previously checked out to this user.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">csDeleted</span><span class="f_Tabletext"> - The package file has been deleted from version control.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="197" style="width:197px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">VersionControlRemove ()</span></p>
</td>
<td valign="top" width="93" style="width:93px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-style: italic;">Void</span></p>
</td>
<td valign="top" width="426" style="width:426px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Removes version control from the package.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Throws an exception if the operation fails. Use </span><span class="f_Tabletext" style="font-style: italic;">GetLastError( )</span><span class="f_Tabletext"> to retrieve error information.</span></p>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
